/* -*- mode: c -*-
 * Copyright (C) 2010, 2011 Lluís Vilanova <vilanova@ac.upc.edu>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef TF_MEM_H
#define TF_MEM_H

#include <stdlib.h>

/** @file Teraflux global memory.
 *
 * Provides @ref tf_mem_get_size bytes of memory on all processes, located at
 * address @ref tf_mem_get_address .
 */

#ifdef __cplusplus
extern "C" {
#endif

/** Returns the address at which the global memory is available.
 *
 * @pre Called after @ref tf_init.
 */
void * tf_mem_get_address (void);

/** Set the address at which the global memory must be available.
 *
 * If not programmatically set, defaults to the value of the environment
 * variable @e TF_MEM_ADDRESS.
 *
 * If none were set (the default) or were set to zero, lets the Operating System
 * choose the address.
 *
 * @pre Called before @ref tf_init.
 */
void tf_mem_set_address (void * address);

/** Returns the size of the global memory. */
size_t tf_mem_get_size (void);

/** Set the size of he global memory.
 *
 * If not programmatically set, defaults to the value of the environment
 * variable @e TF_MEM_SIZE.
 *
 * @pre Called before @ref tf_init.
 */
void tf_mem_set_size (size_t size);



void _tf_mem_init ();

#ifdef __cplusplus
}
#endif

#endif  /* TF_MEM_H */
